Honkit migration - #671
Conversation
Signed-off-by: Kentaro Hayashi <hayashi@clear-code.com>
Signed-off-by: Kentaro Hayashi <hayashi@clear-code.com> Co-Authored-By: Claude <noreply@anthropic.com>
Signed-off-by: Kentaro Hayashi <hayashi@clear-code.com>
Signed-off-by: Kentaro Hayashi <hayashi@clear-code.com>
Signed-off-by: Kentaro Hayashi <hayashi@clear-code.com>
Signed-off-by: Kentaro Hayashi <hayashi@clear-code.com>
Signed-off-by: Kentaro Hayashi <hayashi@clear-code.com> Co-Authored-By: Claude <noreply@anthropic.com>
Signed-off-by: Kentaro Hayashi <hayashi@clear-code.com>
Signed-off-by: Kentaro Hayashi <hayashi@clear-code.com>
✅ Deploy Preview for fluentd-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Signed-off-by: Kentaro Hayashi <hayashi@clear-code.com>
codespell package-lock.json package-lock.json:1343: liNs ==> lines, links, lions, loins, limns 1 Signed-off-by: Kentaro Hayashi <hayashi@clear-code.com>
06acea6 to
75df6bd
Compare
Signed-off-by: Kentaro Hayashi <hayashi@clear-code.com>
Signed-off-by: Kentaro Hayashi <hayashi@clear-code.com>
75df6bd to
c033e25
Compare
Watson1978
left a comment
There was a problem hiding this comment.
These can be fixed later, so I don't think they should block merging this PR.
0.12
-
The images are not displayed.
-
They are embedded as
, so the generated pages request/0.12/.gitbook/assets/.... The redirect rule innetlify.tomlonly matches the site root (from = "/.gitbook/assets/*"), so nothing rewrites the versioned paths and they end up as 404. The files themselves are in place:/0.12/assets/apache-to-mongodb.pngreturns 200. -
Ref. https://deploy-preview-671--fluentd-docs.netlify.app/0.12/articles/apache-to-mongodb.html
-
Adding rules for the sub-books would fix it:
[[redirects]] from = "/0.12/.gitbook/assets/*" to = "/0.12/assets/:splat" status = 200 [[redirects]] from = "/1.0/.gitbook/assets/*" to = "/1.0/assets/:splat" status = 200
-
-
The 0.12 pages are titled
<title>Getting Started · Fluentd 1.0 Documentation</title>. It would be better to show0.12here. This seems to come fromscripts/build.sh, which copies the 1.0book.jsoninto the 0.12 worktree and overwrites its own"title": "Fluentd v0.12 Documentation". -
The raw markdown files are deployed, which is unnecessary.
- Ref. https://deploy-preview-671--fluentd-docs.netlify.app/_build/0.12/input/tail.md (the same applies to
/_build/1.0/) - The
_build/worktrees are created beforenpx honkit buildruns, and honkit does not ignore them, so both branches are copied into the output as assets. Adding_buildto.bookignoreshould be enough.
- Ref. https://deploy-preview-671--fluentd-docs.netlify.app/_build/0.12/input/tail.md (the same applies to
|
Thanks, I'll fix them in another PR. |
HonKit builds heading ids differently from GitBook: it drops backticks, `<`, `>` and `_` from the heading text. The links written for GitBook therefore stopped resolving once #671 and #672 made HonKit the renderer for the published site. | heading | GitBook id | HonKit id | | --------------------------- | -------------------------------------- | -------------- | | `### `add_http_headers`` | add_http_headers | addhttpheaders | | `### `<inject>` Section` | less-than-inject-greater-than-section | inject-section | 15 links across 6 files, 8 distinct anchors: * input/http.md #add_http_headers, #decompression_size_limit * input/syslog.md #source_host_key * output/http.md #allowed_hosts * output/exec_filter.md #less-than-{inject,extract}-greater-than-section * output/file.md #less-than-buffer-greater-than-section * deployment/system-config.md #less-than-source_only_buffer-greater-than-section Verified by building the site with the repository's own configuration and matching every `href="#..."` against the `id=` and `name=` attributes on the same page. Before this change 8 of the 2366 in-page anchors did not resolve; after it, none are left. The new ids were read out of the generated HTML rather than derived from the rule by hand. Signed-off-by: Shizuo Fujita <fujita@clear-code.com>
To fix #659, migrate to Netlify as same as fluentd-website.